/*
 * Copyright [2013-2021], Alibaba Group Holding Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.polardbx.executor.operator.scan;

import com.alibaba.polardbx.executor.chunk.Chunk;
import com.alibaba.polardbx.executor.vectorized.VectorizedExpression;
import org.roaringbitmap.RoaringBitmap;

import java.util.BitSet;

/**
 * Evaluate push-down predicate and store the result into batch and selection.
 *
 * @param <BATCH> class of column batch
 * @param <BITMAP> class of bitmap to store the filtered positions.
 */
public interface LazyEvaluator<BATCH, BITMAP> {

    /**
     * Get bound vectorized expression tree.
     */
    VectorizedExpression getCondition();

    /**
     * Evaluate push-down predicate and store the result into selection array.
     *
     * @param batch the batch produced by row-group reader.
     * @param startPosition the start position of this batch in total file.
     * @param positionCount the position count of this batch.
     * @param deletion the file-level deletion bitmap.
     * @return selection array for input batch.
     */
    BITMAP eval(BATCH batch, int startPosition, int positionCount, RoaringBitmap deletion);

    int eval(BATCH batch, int startPosition, int positionCount, RoaringBitmap deletion, boolean[] bitmap);

    /**
     * Check if this evaluator is a constant expression.
     */
    boolean isConstantExpression();
}
